home *** CD-ROM | disk | FTP | other *** search
/ Carousel Volume 2 #1 / carousel.iso / mactosh / appl / browser.sit / quick tips - READ ME (v.244+) < prev   
Text File  |  1987-05-14  |  9KB  |  159 lines
  1.    Welcome to Browser v.244!  This program enables you to make and browse
  2. indices to very large collections of free-text data.  Read the articles
  3. accompanying the program for comments on design philosophy, algorithms,
  4. data structures, etc.
  5.  
  6. -----------------------------------------------------------------------------
  7.  
  8. This is the help file for Browser v.244.  If you have used Browser v.223 or
  9. earlier versions, please read the warning at the end of this help file!
  10.  
  11. -----------------------------------------------------------------------------
  12.  
  13. In general:
  14.  * if you have problems, try running without a RAM Cache (turn off from 
  15.        the control panel, and reboot) and make sure you have enough memory
  16.        allocated for the program (probably at least 500 KB).
  17.  * use DivJoin, Microsoft Word, or other such programs to join multiple small
  18.        text files together to make suitably-massive files for indexing.
  19.  * when all else fails, call me up and I'll try to help....
  20.  
  21. -----------------------------------------------------------------------------
  22.  
  23. Under the "Browse" menu:
  24.  * select "Open..." to open a previously-created index file for browsing
  25.    - click on a line in the Index window to call up all occurrences of
  26.        that term in the Context window
  27.    - click on a line in the Context window to call up the full text of
  28.        the database in the vicinity of that line
  29.    - select a longer text length from the menu if speed in opening the
  30.        text window is less essential, or if more text around a target
  31.        is desired
  32.    - type into the Index window to jump to a given target location (takes
  33.        a few seconds, longer from floppy)
  34.    - use the Subindex commands to work within a subset of the entire file
  35.        (very useful for large databases)
  36.    - "Empty" empties out the working subindex, "Fill" fills it up again (the
  37.        default startup condition), and "Invert" does a boolean NOT operation
  38.        (so anything that was in the subindex leaves it, and everything that
  39.        was not in the subindex is not included in it)
  40.    - hold down the shift key (cursor turns into a "+") and click on items to
  41.        add their neighborhoods to the working subindex (boolean OR operation);
  42.        hold down the option key (cursor turns into a "-") and click on items
  43.        to remove their neighborhoods from the working subindex (boolean NAND)
  44.    - the Subindex Proximity choices allow you to control the neighborhood or
  45.        region of influence around shift-click and option-click selections for
  46.        the working subindex.  "Words" (the default) selects neighborhoods of
  47.        half a dozen words or so around each click (actually, it selects all
  48.        terms within 32 bytes of the chosen item, and some terms out as far
  49.        as 64 bytes ... read the tech notes or subindex source code for the
  50.        gory details).  "Sentences" selects neighborhoods within a few sentences
  51.        of the selected items, and "Paragraphs" selects neighborhoods of
  52.        within a few paragraphs.
  53.  
  54. EXAMPLE:
  55.    You have indexed up the past year of on-line sessions you've had, and want
  56. to recall items concerned with the format of MacWrite documents.  Choose
  57. "Open..." from under the Browser menu and open the already-indexed file.
  58. Scroll to "MACWRITE" in the index ... it occurs 2,345 times, far too many to
  59. effectively browse through.  So, choose "Empty" to clear out the working
  60. subindex and then shift-click on MACWRITE.  Now all 2,345 neighborhoods of
  61. the occurrences of MACWRITE are marked as valid.  Scroll the index window
  62. to FORMAT and see that only 2 out of the 987 occurrences of FORMAT occurred
  63. within a few words of MACWRITE.  Click on FORMAT and see those two occurrences
  64. in context.  If they don't answer your questions, go back to MACWRITE, change
  65. the Proximity neighborhood from "Words" to "Sentences" (or even "Paragraphs")
  66. and shift-click again, to broaden out the selected subindex.  Now check back
  67. under FORMAT and see that 31 of the 987 occurrences are marked valid; browse
  68. through them, and find the desired items.
  69.  
  70. -----------------------------------------------------------------------------
  71.  
  72. Under the "Index" menu:
  73. select "New..." to start creating an inverted index to a text file
  74.    - index creation goes on in background while you can browse another file
  75.     (unless you select Fast Index option, in which case everything else
  76.     mostly locks up but indexing goes about 3 times faster)
  77.    - don't quit the main program while indexing is still occurring, or you'll
  78.        have to throw away the partially-sorted "....Index" file and the
  79.        "Temporary Radix Sort File" before running again
  80.    - don't attempt to index a file that already has an index, and don't index
  81.        a file which has a name longer than 25 letters
  82.    - be sure that you have at least 6 times the space free on your disk as
  83.        the length of the original text file to be indexed (the index file
  84.        occupies up to 3 times the space of the original text, and a temporary
  85.        sort file of that same size is also needed during indexing)
  86.    - use Omit Words options to leave out undesired terms from your indices
  87.        and thereby make them smaller (and get around the 6x space requirement
  88.        above) ... index sorting also goes faster when words are omitted
  89.    - the status window displays progress of an index operation:  gray bar shows
  90.        amount of index-building scan completed, and black bar then shows
  91.        proportion of index-sorting that has been finished; the window updates
  92.        about once/second (when you're not in Fast Index mode)
  93.    - you can turn options like Fast Index on/off during indexing (though it
  94.        doesn't make much sense to change the Omit Words choices during the
  95.        course of index generation); hold down the mouse button and wait
  96.        for the disk to spin in order to get a chance to do something while
  97.        Fast Index is on
  98.  
  99. -----------------------------------------------------------------------------
  100.  
  101. Under the "File" and "Edit" menus:
  102.  * the editor is a modified version of the Sibley Editor supplied with MacForth,
  103.        and copyright restrictions prevent me from sending out the source code
  104.        unless you are a MacForth purchaser (and if you have MacForth, you can
  105.        run the Browser from within MacForth with the full-up Forth interpreting
  106.        version of the Sibley Editor -- a powerful combination! One caveat:  the
  107.        default Sibley Editor uses numerous OUTFILE commands and thus prevents
  108.        Browser windows from always updating properly ... if a window isn't
  109.        refreshed when you uncover it, click in it and scroll a bit and that
  110.        should cure the problem).
  111.    - editor commands are pretty standard; things get slow if the files being
  112.        edited are very big (over 50 KB or so), so stick to shorter files
  113.    - you have up to four windows available into four different text files
  114.    - don't launch another application while building an index, as mentioned
  115.        in connection with "Quit" command earlier
  116.    - "Margin" under the Edit menu re-word-wraps the current selection to fit the
  117.        current screen margins
  118.    - The editor is memory-based, so don't try to edit too big a file
  119.    - The editor is the newest thing in the package, so please watch out
  120.        carefully for bugs in it (and in its interactions with the rest of the
  121.        program ... for instance, you may have to click on another Browser
  122.        window before clicking on an editor window in order to get the "Edit"
  123.        menu activated, if a Desk Accessory was the front window ... I'll try
  124.        to fix that someday, if I can make it happen consistently).
  125.  
  126. -----------------------------------------------------------------------------
  127.  
  128.  
  129. Send suggestions for improvements, and details of bugs, to:
  130.  
  131.   Mark Zimmermann
  132.   9511 Gwyndale Drive
  133.   Silver Spring, MD  20910
  134.  
  135. phone (301)565-2166 (home) or (703)482-9572 (ofc, rarely in)
  136.  
  137. arpanet:  science@nems.arpa
  138.  
  139. CompuServe:  75066,2044
  140.  
  141. -----------------------------------------------------------------------------
  142.  
  143. For users of earlier Browser releases:
  144.  
  145.   WARNING -- in versions of Browser before 0.224 there is a problem that may
  146. cause some words to be omitted and others to be duplicated in big indices!  It
  147. is associated with the behavior of MacForth's WRITE.VIRTUAL command for file
  148. I/O, and ONLY occurs with an index file when an alphanumeric character appears
  149. more than 255 times in column 12 of the indexed word list.  (For normal English
  150. text this won't happen until the file being indexed is over 1.5 MB long, and
  151. only 256 index terms will be messed up out of 80,000+.)
  152.  
  153.   THUS -- if you are using a version prior to v.224, please send me a disk
  154. and a self-addressed stamped envelope for a more recent release, if you need
  155. to work with big files.  If you have used an early version to make some big
  156. index files, please throw those indices away and reindex.
  157.  
  158.  
  159.